com.highdeal.pnr.hci

Class AccountOperation

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.pnr.hci.AccountOperation

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

public class AccountOperation
extends HCIModelAdapter

This class represents an account operation generated by the SAP CC system during the charging process; Account operations are available in the charging results.

An account operation contains:

• A numeric key
• A numeric key for the account operation it depends on, if any
• A type
• A price amount
• A net amount
• A tax amount
• A main amount reference
• A list of amount assignments

See Also:

ChargingResult

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="accountOperation">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="amountAssignment" minOccurs="0" maxOccurs="unbounded" />
     </xs:sequence>
     <xs:attribute name="key" type="xs:int" use="required" />
     <xs:attribute name="dependentAccountOperationKey" type="xs:int" use="required" />
     <xs:attribute name="type" type="xs:string" use="required" />
     <xs:attribute name="mainAccountReferenceType" type="xs:string" use="required" />
     <xs:attribute name="mainAccountReferenceId" type="xs:string" use="required" />
     <xs:attribute name="amount" type="xs:string" use="required" />
     <xs:attribute name="netAmount" type="xs:string" use="required" />
     <xs:attribute name="taxAmount" type="xs:string" use="required" />
   </xs:complexType>
 </xs:element>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccountOperation.AccountOperationType This enumeration lists the possible types for an account operation.
static class	AccountOperation.AccountReference This class represents a reference to an account impacted by a charging operation.
static class	AccountOperation.AccountReferenceType This enumeration lists the possible types for an account reference.
static class	AccountOperation.AmountAssignment This class represents the assignment of part of the amount of an account operation to an account.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_NAME The XML tag name of this object: "accountOperation"

Constructor Summary

Constructors

Constructor and Description
AccountOperation() Builds an uninitialized account operation.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
Money	getAmount() Gets the amount of the account operation.
List<AccountOperation.AmountAssignment>	getAmountAssignments() Gets the list of amount assignments of the account operation.
int	getDependentAccountOperationKey() Gets the numeric key of the account operation the the account operation depends on.
int	getKey() Gets the numeric key of the account operation.
AccountOperation.AccountReference	getMainAccountReference() Gets the main amount reference of the account operation.
Money	getNetAmount() Gets the net amount of the account operation.
String	getTagName() Gets the XML tag name of the HCI model.
Money	getTaxAmount() Gets the tax amount of the account operation.
AccountOperation.AccountOperationType	getType() Gets the type of the account operation.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAmount(Money amount) Sets the amount of the account operation.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setDependentAccountOperationKey(int dependentAccountOperationKey) Sets the numeric key of the account operation the account operation depends on.
void	setKey(int key) Sets the numeric key of the account operation.
void	setMainAccountReference(AccountOperation.AccountReference mainAccountReference) Sets the main amount reference of the account operation.
void	setNetAmount(Money netAmount) Sets the net amount of the account operation.
void	setTaxAmount(Money taxAmount) Sets the tax amount of the account operation.
void	setType(AccountOperation.AccountOperationType type) Sets the type of the account operation.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

The XML tag name of this object: "accountOperation"

See Also:

Constant Field Values

Constructor Detail

AccountOperation

public AccountOperation()

Builds an uninitialized account operation.

Method Detail

getKey

public int getKey()

Gets the numeric key of the account operation.

Returns:

The numeric key of the account operation

setKey

public void setKey(int key)

Sets the numeric key of the account operation.

Parameters:

key - The numeric key of the account operation

getDependentAccountOperationKey

public int getDependentAccountOperationKey()

Gets the numeric key of the account operation the the account operation depends on.

Returns:

The numeric key of the account operation the account operation depends on, or -1 if the account operation has no dependency

setDependentAccountOperationKey

public void setDependentAccountOperationKey(int dependentAccountOperationKey)

Sets the numeric key of the account operation the account operation depends on.

Parameters:

dependentAccountOperationKey - The numeric key of the account operation the account operation depends on

getType

public AccountOperation.AccountOperationType getType()

Gets the type of the account operation.

Returns:

The type of the account operation

setType

public void setType(AccountOperation.AccountOperationType type)

Sets the type of the account operation.

Parameters:

type - The type of the account operation

getAmount

public Money getAmount()

Gets the amount of the account operation.

Returns:

The amount of the account operation

setAmount

public void setAmount(Money amount)

Sets the amount of the account operation.

Parameters:

amount - The amount of the account operation

getNetAmount

public Money getNetAmount()

Gets the net amount of the account operation.

Returns:

The net amount of the account operation

setNetAmount

public void setNetAmount(Money netAmount)

Sets the net amount of the account operation.

Parameters:

netAmount - The net amount of the account operation

getTaxAmount

public Money getTaxAmount()

Gets the tax amount of the account operation.

Returns:

The tax amount of the account operation

setTaxAmount

public void setTaxAmount(Money taxAmount)

Sets the tax amount of the account operation.

Parameters:

taxAmount - The tax amount of the account operation

getMainAccountReference

public AccountOperation.AccountReference getMainAccountReference()

Gets the main amount reference of the account operation.

Returns:

The main amount reference of the account operation

setMainAccountReference

public void setMainAccountReference(AccountOperation.AccountReference mainAccountReference)

Sets the main amount reference of the account operation.

Parameters:

mainAccountReference - The main amount reference of the account operation

getAmountAssignments

public List<AccountOperation.AmountAssignment> getAmountAssignments()

Gets the list of amount assignments of the account operation.

Returns:

The list of amount assignments of the account operation

getTagName

public String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Returns:

The XML tag name

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into